Skip to content

[search] Refactor: make the search code more testable. #12107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 23 commits into from
Closed

[search] Refactor: make the search code more testable. #12107

wants to merge 23 commits into from

Conversation

@jayaddison
Copy link
Contributor

@jayaddison jayaddison commented Mar 16, 2024

Feature or Bugfix

  • Refactoring

Purpose

  • Make it easier to write and run tests for the HTML search JavaScript code by extracting functions that can be called individually to parse queries and perform searches, without running any display/DOM-related logic.

Detail

  • Extract Search._parseQuery to transform a query into search terms.
  • Extract Search._performSearch to run a query and return results using search term arguments.
  • Update the test suite to use the newly-extracted functions.

Relates

jayaddison and others added 10 commits March 15, 2024 18:33
@jayaddison jayaddison mentioned this pull request Mar 16, 2024
Merged
jayaddison and others added 8 commits March 18, 2024 19:17
@jayaddison
Merge branch 'master' into issue-12099-prep/extract-js-search-index-f…
b33d331 
…ixtures
@jayaddison
Merge branch 'issue-12099-utils/fixture-regeneration' into issue-1209…
55b6072 
…9-prep/extract-js-search-index-fixtures

Conflicts:
	sphinx/themes/basic/static/searchtools.js
@jayaddison
[tests] Regenerate test fixtures by running 'python utils/generate_js…
ee4316d 
…_fixtures.py'
@jayaddison
Merge branch 'issue-12099-prep/extract-js-search-index-fixtures' into…
0634502 
… refactor/extract-search-result-gathering
@jayaddison
[utils] Add script to regenerate JavaScript test fixtures
0bc558a
@jayaddison
[utils] Remove beautification step for generated searchindex.js files.
a74bc15 
Ref: #12102 (comment)
@jayaddison
Merge branch 'issue-12099-utils/fixture-regeneration' into refactor/e…
a037867 
…xtract-search-result-gathering

Conflicts:
	utils/generate_js_fixtures.py
@jayaddison
[tests] Regenerate searchindex.js files.
68a6504
@jayaddison
Copy link
Contributor Author

jayaddison commented Mar 22, 2024

Awaits possible merge of #12102; moving into draft status until then.

@jayaddison jayaddison marked this pull request as draft March 22, 2024 14:29
@jayaddison
Copy link
Contributor Author

jayaddison commented Mar 26, 2024

Awaits possible merge of #12102; moving into draft status until then.

It seems I've unintentionally merged most of this into #12102. I'll close this and merge the remainder too, so that there's only one PR to review. It could make sense to separate some of it out again, but to begin with a single PR should be less confusing I expect.

@jayaddison jayaddison closed this Mar 26, 2024
@jayaddison jayaddison deleted the refactor/extract-search-result-gathering branch March 26, 2024 11:28
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

No one assigned

Labels

html search internals:refactoring javascript Pull requests that update Javascript code type:tests

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@jayaddison